Schema bimoR.v1
Schema bimoR.v1 : Element getReportResponse
Element getReportResponse
Opis
Rezultat przetworzenia zapytania o raport
Element wyjściowy dla operacji zamówienia raportu (getReportRequest) w BIG API.
Przestrzeń nazw http://api.big.pl/bimoR/v1
Typ
Typ złożony GetReportResponse
Diagram
Element success Element identificationError Element requestError Element authorisationError Choice Element getReportResponse
Przegląd
getReportResponse Typ złożony GetReportResponse
Rezultat przetworzenia zapytania o raport
Element wyjściowy dla operacji zamówienia raportu (getReportRequest) w BIG API.
Choice
authorisationError Typ złożony AuthorisationError
Błąd autoryzacji
Sequence
errorType Typ prosty authErrorTypeEnum
Typ błędu autoryzacji
Typ błędu autoryzacji związany z rezultatem przetwarzania komunikatu przez system.
errorDescription Typ prosty string
Opis typu błędu autoryzacji
Opis typu błędu autoryzacji związany z rezultatem przetwarzania komunikatu przez system.
requestError Typ złożony RequestError
Błąd walidacji zapytania
Sequence
currentRequest optional Typ złożony RequestAbstract
Bieżące zapytanie
operationType optional Typ prosty getOperationTypeEnum
Rodzaj operacji
Kod określający rodzaj wywołanej operacji, dla której system przeprowadził walidację zapytania
validationError 1..∞ Typ złożony ValidationError
Błąd walidacji
Kolekcja wykrytych przez system błędów walidacji
Sequence
orderNumber Typ prosty int6
Numer kolejny błędu
Numer kolejny błędu walidacji wykrytego w komunikacie. Numeracja zaczyna się od „1”.
validationRuleId Typ prosty string32
Kod błędu
Kod błędu walidacji
message optional Typ prosty string
Opis błędu
Opis błędu walidacji
faultyElementPath optional Typ prosty string
XPath
XPath do błędnej ścieżki komunikatu
dependentElementPath optional Typ prosty string
Xpath do pola zależnego
Xpath do pola zależnego, względem pola, do którego zgłoszony został błąd (@ValidationError.faultyElementPath)
identificationError Typ złożony IdentificationError
Błąd identyfikacji przedmiotu zapytania
Sequence
currentRequest Typ złożony GetReportRequest
Bieżące zapytanie o raport
referenceReportId optional Typ prosty string32
Identyfikator raportu referencyjnego
Identyfikator wcześniej uzyskanego raportu BIG InfoMonitor. Przekazywany w celu powiązania tego historycznego raportu ze złożonym aktualnie zapytaniem. Raporty dotyczące wyłącznie danych ze źródeł zewnętrznych (spoza BIG InfoMonitor), wymagają wskazania referencyjnego zapytania dotyczącego raportu z danymi z BIG InfoMonitor.
Powiązane reguły walidacji:

Identyfikator Opis
RR49 W rejestrze zapytań subskrybenta składającego zapytanie powtórzone, musi być zapisane dokładnie jedno zapytanie o przekazanym numerze
RR50 Dane zapytania przekazane w zapytaniu powtórzonym musi być zgodne z zapytaniem przekazanym w zapytaniu powtarzanym zidentyfikowanym na podstawie przekazanego numeru referencyjnego. (ten sam rodzaj produktu, zestaw komponentów, danych podmiotu pytanego)
RR68 Identyfikator referencyjnego (pierwotnego) raportu z rejestru zapytań przekazany w żądaniu ponowienia pobrania raportu, musi wskazywać raport z rejestru pobrany przez subskrybenta żądającego ponowienia.
RR71 Zapytanie musi zawierać identyfikator raportu referencyjnego, jeżeli dotyczy produktu bikScoring lub bikVerification.
RR72 Identyfikator raportu referencyjnego przekazany w zapytaniu o produkt bikScoring i bikVerification musi wskazywać raport zamówiony przez subskrybenta.
RR73 Identyfikator raportu referencyjnego przekazany w zapytaniu o produkt bikScoring i bikVerification musi wskazywać raport zamówiony w dniu złożonego zapytania.
Sequence
Choice
client Typ złożony Subscriber
Subskrybent
Subskrybent BIG API składający zapytanie
proxy Typ złożony Proxy
Przedstawiciel innego subskrybenta
Informacje o przedstawicielu klienta BIG IM, wywołującym operację BIG API w jego imieniu.
repeatedRequestMarker optional xs:boolean
Znacznik powtórzonej operacji
Znacznik określający, czy komunikat jest żądaniem powtórzenia zapytania
Powiązane reguły walidacji:

Identyfikator Opis
RR49 W rejestrze zapytań subskrybenta składającego zapytanie powtórzone, musi być zapisane dokładnie jedno zapytanie o przekazanym numerze
RR50 Dane zapytania przekazane w zapytaniu powtórzonym musi być zgodne z zapytaniem przekazanym w zapytaniu powtarzanym zidentyfikowanym na podstawie przekazanego numeru referencyjnego. (ten sam rodzaj produktu, zestaw komponentów, danych podmiotu pytanego)
reportComposition Typ złożony Composition
Kompozycja raportu
Definicja kompozycji zamawianego produktu
success Typ złożony Report
Pozytywny rezultat przetworzenia zapytania o raport.
Sequence
currentRequest Typ złożony GetReportRequest
Bieżące zapytanie o raport
referenceReportId optional Typ prosty string32
Identyfikator raportu referencyjnego
Identyfikator wcześniej uzyskanego raportu BIG InfoMonitor. Przekazywany w celu powiązania tego historycznego raportu ze złożonym aktualnie zapytaniem. Raporty dotyczące wyłącznie danych ze źródeł zewnętrznych (spoza BIG InfoMonitor), wymagają wskazania referencyjnego zapytania dotyczącego raportu z danymi z BIG InfoMonitor.
Powiązane reguły walidacji:

Identyfikator Opis
RR49 W rejestrze zapytań subskrybenta składającego zapytanie powtórzone, musi być zapisane dokładnie jedno zapytanie o przekazanym numerze
RR50 Dane zapytania przekazane w zapytaniu powtórzonym musi być zgodne z zapytaniem przekazanym w zapytaniu powtarzanym zidentyfikowanym na podstawie przekazanego numeru referencyjnego. (ten sam rodzaj produktu, zestaw komponentów, danych podmiotu pytanego)
RR68 Identyfikator referencyjnego (pierwotnego) raportu z rejestru zapytań przekazany w żądaniu ponowienia pobrania raportu, musi wskazywać raport z rejestru pobrany przez subskrybenta żądającego ponowienia.
RR71 Zapytanie musi zawierać identyfikator raportu referencyjnego, jeżeli dotyczy produktu bikScoring lub bikVerification.
RR72 Identyfikator raportu referencyjnego przekazany w zapytaniu o produkt bikScoring i bikVerification musi wskazywać raport zamówiony przez subskrybenta.
RR73 Identyfikator raportu referencyjnego przekazany w zapytaniu o produkt bikScoring i bikVerification musi wskazywać raport zamówiony w dniu złożonego zapytania.
Sequence
Choice
client Typ złożony Subscriber
Subskrybent
Subskrybent BIG API składający zapytanie
proxy Typ złożony Proxy
Przedstawiciel innego subskrybenta
Informacje o przedstawicielu klienta BIG IM, wywołującym operację BIG API w jego imieniu.
repeatedRequestMarker optional xs:boolean
Znacznik powtórzonej operacji
Znacznik określający, czy komunikat jest żądaniem powtórzenia zapytania
Powiązane reguły walidacji:

Identyfikator Opis
RR49 W rejestrze zapytań subskrybenta składającego zapytanie powtórzone, musi być zapisane dokładnie jedno zapytanie o przekazanym numerze
RR50 Dane zapytania przekazane w zapytaniu powtórzonym musi być zgodne z zapytaniem przekazanym w zapytaniu powtarzanym zidentyfikowanym na podstawie przekazanego numeru referencyjnego. (ten sam rodzaj produktu, zestaw komponentów, danych podmiotu pytanego)
reportComposition Typ złożony Composition
Kompozycja raportu
Definicja kompozycji zamawianego produktu
exchangeRateTable optional Typ złożony ExchangeRateTable
Tabela kursów walut
Informacje o użytej tabeli kursów walut NBP. Występują jeśli tabela jest wykorzystywana przez conajmniej jeden komponent raportu.
Sequence
id Typ prosty string
Numer tabeli kursów walut
Numer tabeli kursów walut Narodowego Banku Polskiego.
date Typ prosty date
Data tabeli kursów walut
Data publikacji tabeli kursów walut Narodowego Banku Polskiego.
components Typ złożony ReportComponents
Komponenty raportu
Kolekcja zamówionych komponentów raportu. Każdy komponent zawiera informacje dotyczące przedmiotu zapytania w odpowiedniej dla niego strukturze komunikatu.
Sequence
reportComponent 0..∞ Typ złożony ReportComponent
Komponent raportu
Kolekcja komponentów raportu
customComponent 0..∞ Typ złożony CustomComponent
Dedykowany komponent raportu
Kolekcja dedykowanych komponentów raportu
Źródło
<xs:element name="getReportResponse" type="br:GetReportResponse" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:annotation>
    <xs:documentation>
      <div class="nazwa pl-PL" xmlns="http://www.w3.org/1999/xhtml">Rezultat przetworzenia zapytania o raport</div>
      <div class="opis pl-PL" xmlns="http://www.w3.org/1999/xhtml">Element wyjściowy dla operacji zamówienia raportu (getReportRequest) w BIG API.</div>
    </xs:documentation>
  </xs:annotation>
</xs:element>
Zobacz także
Schema bimoR.v1